<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_multi_buffer::prepare</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../boost__beast__basic_multi_buffer.html" title="basic_multi_buffer">
<link rel="prev" href="cdata.html" title="basic_multi_buffer::cdata">
<link rel="next" href="commit.html" title="basic_multi_buffer::commit">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="cdata.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_multi_buffer.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="commit.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="beast.ref.boost__beast__basic_multi_buffer.prepare"></a><a class="link" href="prepare.html" title="basic_multi_buffer::prepare">basic_multi_buffer::prepare</a>
</h5></div></div></div>
<p>
          <a class="indexterm" name="idm9148"></a>
        </p>
<p>
          Returns a mutable buffer sequence representing writable bytes.
        </p>
<h6>
<a name="beast.ref.boost__beast__basic_multi_buffer.prepare.h0"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.synopsis"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_buffer.prepare.synopsis">Synopsis</a>
        </h6>
<pre class="programlisting"><span class="identifier">mutable_buffers_type</span>
<span class="identifier">prepare</span><span class="special">(</span>
    <span class="identifier">size_type</span> <span class="identifier">n</span><span class="special">);</span>
</pre>
<h6>
<a name="beast.ref.boost__beast__basic_multi_buffer.prepare.h1"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.description"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_buffer.prepare.description">Description</a>
        </h6>
<p>
          Returns a mutable buffer sequence representing the writable bytes containing
          exactly <code class="computeroutput"><span class="identifier">n</span></code> bytes of storage.
          Memory may be reallocated as needed. All buffer sequences previously obtained
          using <a class="link" href="prepare.html" title="basic_multi_buffer::prepare"><code class="computeroutput"><span class="identifier">prepare</span></code></a> are invalidated. Buffer
          sequences previously obtained using <a class="link" href="data.html" title="basic_multi_buffer::data"><code class="computeroutput"><span class="identifier">data</span></code></a> remain valid.
        </p>
<h6>
<a name="beast.ref.boost__beast__basic_multi_buffer.prepare.h2"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.parameters"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_buffer.prepare.parameters">Parameters</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Name
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody><tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">n</span></code>
                  </p>
                </td>
<td>
                  <p>
                    The desired number of bytes in the returned buffer sequence.
                  </p>
                </td>
</tr></tbody>
</table></div>
<h6>
<a name="beast.ref.boost__beast__basic_multi_buffer.prepare.h3"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.exceptions"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_buffer.prepare.exceptions">Exceptions</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Type
                  </p>
                </th>
<th>
                  <p>
                    Thrown On
                  </p>
                </th>
</tr></thead>
<tbody><tr>
<td>
                  <p>
                    <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">length_error</span></code>
                  </p>
                </td>
<td>
                  <p>
                    if <a class="link" href="size.html" title="basic_multi_buffer::size"><code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code></a>
                    + n exceeds <a class="link" href="max_size.html" title="basic_multi_buffer::max_size"><code class="computeroutput"><span class="identifier">max_size</span><span class="special">()</span></code></a>.
                  </p>
                </td>
</tr></tbody>
</table></div>
<h6>
<a name="beast.ref.boost__beast__basic_multi_buffer.prepare.h4"></a>
          <span class="phrase"><a name="beast.ref.boost__beast__basic_multi_buffer.prepare.exception_safety"></a></span><a class="link" href="prepare.html#beast.ref.boost__beast__basic_multi_buffer.prepare.exception_safety">Exception
          Safety</a>
        </h6>
<p>
          Strong guarantee.
        </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="cdata.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_multi_buffer.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="commit.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
